/*
 *   The contents of this file are subject to the Mozilla Public License
 *   Version 1.1 (the "License"); you may not use this file except in
 *   compliance with the License. You may obtain a copy of the License at
 *   http://www.mozilla.org/MPL/
 *
 *   Software distributed under the License is distributed on an "AS IS"
 *   basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 *   License for the specific language governing rights and limitations
 *   under the License.
 *
 *   The Original Code is Matra - the DTD Parser.
 *
 *   The Initial Developer of the Original Code is Conrad S Roche.
 *   Portions created by Conrad S Roche are Copyright (C) Conrad 
 *   S Roche. All Rights Reserved.
 *
 *   Alternatively, the contents of this file may be used under the terms
 *   of the GNU GENERAL PUBLIC LICENSE Version 2 or any later version
 *   (the  "[GPL] License"), in which case the
 *   provisions of GPL License are applicable instead of those
 *   above.  If you wish to allow use of your version of this file only
 *   under the terms of the GPL License and not to allow others to use
 *   your version of this file under the MPL, indicate your decision by
 *   deleting  the provisions above and replace  them with the notice and
 *   other provisions required by the GPL License.  If you do not delete
 *   the provisions above, a recipient may use your version of this file
 *   under either the MPL or the GPL License."
 *
 *   [NOTE: The text of this Exhibit A may differ slightly from the text of
 *   the notices in the Source Code files of the Original Code. You should
 *   use the text of this Exhibit A rather than the text found in the
 *   Original Code Source Code for Your Modifications.]
 *
 * Created: Conrad S Roche <derupe at users.sourceforge.net>,  21-Sep-2003
 */
package com.conradroche.dtd.decl.elem;

import java.util.Collection;

/**
 * Holds a composite CP that holds either choice lists of 
 * content particles, or sequence lists of content particles.
 *
 * @author Conrad Roche
 */
public interface CompositeContentParticle extends ContentParticle {

	/**
	 * Identifies the type of composition to be choice.
	 */
	public static final short CP_TYPE_CHOICE = 1;

	/**
	 * Identifies the type of composition to be sequence.
	 */
	public static final short CP_TYPE_SEQUENCE = 2;
	
	/**
	 * Returns the type for this Composite CP. The value returned
	 * can be either <code>CP_TYPE_CHOICE</code> if this is a
	 * "choice lists of content particles" or
	 * <code>CP_TYPE_SEQUENCE</code> if this is a
	 * "sequence lists of content particles".
	 * 
	 * @see #setCPType
	 * 
	 * @return <code>CP_TYPE_CHOICE</code> if this is a
	 * "choice lists of content particles" or
	 * <code>CP_TYPE_SEQUENCE</code> if this is a
	 * "sequence lists of content particles".
	 */
	public short getCPType();
	
	/**
	 * Sets the type for this Composite CP.
	 * The value passed can be either 
	 * <code>CP_TYPE_CHOICE</code> if this is a
	 * "choice lists of content particles" or
	 * <code>CP_TYPE_SEQUENCE</code> if this is a
	 * "sequence lists of content particles".
	 * 
	 * @see #getCPType
	 * 
	 * @param type The type for this Composite CP.
	 */
	public void setCPType(short type);
	
	/**
	 * Sets the list of ContentParticle associated
	 * with this CompositeContentParticle.
	 * 
	 * @see #getCPList
	 * 
	 * @param list List of ContentParticle
	 */
	public void setCPList(Collection list);
	
	/**
	 * Returns the list of ContentParticle associated
	 * with this CompositeContentParticle.
	 * 
	 * @see #setCPList
	 * 
	 * @return List of ContentParticle.
	 */
	public Collection getCPList();
}
